Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

test: fix undocumented assumptions about the timing of tsfn calls #995

Closed
wants to merge 2 commits into from
Closed

test: fix undocumented assumptions about the timing of tsfn calls #995

wants to merge 2 commits into from

Conversation

legendecas
Copy link
Member

@legendecas legendecas commented May 10, 2021 •
edited
Loading

Fixes #994

@legendecas legendecas mentioned this pull request May 10, 2021
Closed
indutny-signal
indutny-signal approved these changes May 10, 2021
View reviewed changes
Copy link

@indutny-signal indutny-signal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Node.js didn't need the test change because we increased the array size to be over 1000 elements:

nodejs/node@7abc7e4#diff-7025abd678052220b281a720c8e5f2b995120dd65ccd8f8557b0158a1a43025bR10

I think this change is good as it is, but just wanted to suggest some alternatives.

test/threadsafe_function/threadsafe_function.js
@@ -25,11 +25,9 @@ async function test(binding) {
binding.threadsafe_function[threadStarter](function testCallback(value) {
array.push(value);
if (array.length === quitAfter) {
setImmediate(() => {
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or you could use process.nextTick if you'd like to keep it.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't know the exact intention of deferring the close of TSFN here. However, tests all passed with or without deferring.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, original TSFN implementation was re-scheduling each call on the next physical UV loop tick (which was terribly slow), so the setImmediate() got a chance to run right after the first invocation.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@KevinEady @gabrielschulhof any input on using/not using process.nextTick(). I'll plan to land this tomorrow unless I hear from you so that we can get back to green CI.

@legendecas
Copy link
Member Author

So the related patch doesn't seem to be released on the latest v16.x. We don't have GitHub Actions setup for nightly Node.js builds... (as nightly build probably fails for arbitrary reasons)�¯_(ツ)_/¯, what can we do here? This test fixup doesn't break all existing releasing lines. And I've tested against the latest main branch of Node.js.

@legendecas legendecas marked this pull request as ready for review May 10, 2021 17:34
@mhdawson
Copy link
Member

Ran on a few of the versions in our CI, its possibly there are other places with the same issue:

https://ci.nodejs.org/view/x%20-%20Abi%20stable%20module%20API/job/node-test-node-addon-api-new/4087/nodes=rhel7-s390x/console

Running test 'threadsafe_function/threadsafe_function_sum'
Running test 'threadsafe_function/threadsafe_function_unref'
Running test 'typed_threadsafe_function/typed_threadsafe_function'
FATAL ERROR: TypedDataSourceThread Queue was never closing
Tests aborted with SIGSEGV

@mhdawson
Copy link
Member

@legendecas , Well actually just looks like the similar typed version of the test likely needs the same fix

@mhdawson
Copy link
Member

mhdawson commented May 11, 2021 •
edited
Loading

CI run on master - https://ci.nodejs.org/view/x%20-%20Abi%20stable%20module%20API/job/node-test-node-addon-api-new/4097/

@mhdawson
Copy link
Member

Run on 16.x - https://ci.nodejs.org/view/x%20-%20Abi%20stable%20module%20API/job/node-test-node-addon-api-new/4098/

@mhdawson
Copy link
Member

Run on 12.x - https://ci.nodejs.org/view/x%20-%20Abi%20stable%20module%20API/job/node-test-node-addon-api-new/4099/

Run on 14.x - https://ci.nodejs.org/view/x%20-%20Abi%20stable%20module%20API/job/node-test-node-addon-api-new/4100/

@mhdawson
Copy link
Member

CI runs were good. I'll land to unbreak the CI.

mhdawson
mhdawson approved these changes May 11, 2021
View reviewed changes
Copy link
Member

@mhdawson mhdawson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

mhdawson pushed a commit that referenced this pull request May 11, 2021
@legendecas @mhdawson
test: fix undoc assumptions about the timing of tsfn calls
da3bd57 
PR-URL: #995
Reviewed-By: Michael Dawson <[email protected]>
@mhdawson
Copy link
Member

mhdawson commented May 11, 2021 •
edited
Loading

Landed as: da3bd57

CI across versions on what's landed:
https://ci.nodejs.org/view/x%20-%20Abi%20stable%20module%20API/job/node-test-node-addon-api-LTS%20versions/1125/

@mhdawson
Copy link
Member

CI run was all green. @legendecas thanks for helping get this resolved so quickly. @indutny-signal thanks for helping out as well.

@mhdawson mhdawson closed this May 11, 2021
@legendecas legendecas deleted the test-tsfn branch May 11, 2021 17:20
deepakrkris pushed a commit to deepakrkris/node-addon-api that referenced this pull request Sep 23, 2021
@legendecas
test: fix undoc assumptions about the timing of tsfn calls
a1c102a 
PR-URL: nodejs#995
Reviewed-By: Michael Dawson <[email protected]>
deepakrkris pushed a commit to deepakrkris/node-addon-api that referenced this pull request Oct 15, 2021
@legendecas
test: fix undoc assumptions about the timing of tsfn calls
6437aaf 
PR-URL: nodejs#995
Reviewed-By: Michael Dawson <[email protected]>
kevindavies8 added a commit to kevindavies8/node-addon-api-Develop that referenced this pull request Aug 24, 2022
@kevindavies8
test: fix undoc assumptions about the timing of tsfn calls
5f85eef 
PR-URL: nodejs/node-addon-api#995
Reviewed-By: Michael Dawson <[email protected]>
Marlyfleitas added a commit to Marlyfleitas/node-api-addon-Development that referenced this pull request Aug 26, 2022
@Marlyfleitas
test: fix undoc assumptions about the timing of tsfn calls
096a747 
PR-URL: nodejs/node-addon-api#995
Reviewed-By: Michael Dawson <[email protected]>
wroy7860 added a commit to wroy7860/addon-api-benchmark-node that referenced this pull request Sep 19, 2022
@wroy7860
test: fix undoc assumptions about the timing of tsfn calls
29a9b69 
PR-URL: nodejs/node-addon-api#995
Reviewed-By: Michael Dawson <[email protected]>
johnfrench3 pushed a commit to johnfrench3/node-addon-api-git that referenced this pull request Aug 11, 2023
test: fix undoc assumptions about the timing of tsfn calls
60964c1 
PR-URL: nodejs/node-addon-api#995
Reviewed-By: Michael Dawson <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@indutny indutny indutny left review comments

@indutny-signal indutny-signal indutny-signal approved these changes

@mhdawson mhdawson mhdawson approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

threadsafe_function test - CI failing on Master since May 4th
4 participants
@legendecas @mhdawson @indutny @indutny-signal